<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityEncodingManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/sakaiproject/entitybus/rest/EntityEncodingManager.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityEncodingManager.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-rest/xref/org/sakaiproject/entitybus/rest/EntityEncodingManager.html $</em>
<a name="4" href="#4">4</a>   <em> * EntityEncodingManager.java - entity-broker - Jul 23, 2008 3:25:32 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.<strong>rest</strong>;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.IOException;
<a name="24" href="#24">24</a>  <strong>import</strong> java.io.InputStream;
<a name="25" href="#25">25</a>  <strong>import</strong> java.io.OutputStream;
<a name="26" href="#26">26</a>  <strong>import</strong> java.io.UnsupportedEncodingException;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.HashMap;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.List;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.Map;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.Map.Entry;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <strong>import</strong> javax.servlet.http.HttpServletRequest;
<a name="33" href="#33">33</a>  <strong>import</strong> javax.servlet.http.HttpServletResponse;
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="36" href="#36">36</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="37" href="#37">37</a>  <strong>import</strong> org.azeckoski.reflectutils.ConstructorUtils;
<a name="38" href="#38">38</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="39" href="#39">39</a>  <strong>import</strong> org.azeckoski.reflectutils.StringUtils;
<a name="40" href="#40">40</a>  <strong>import</strong> org.azeckoski.reflectutils.map.ArrayOrderedMap;
<a name="41" href="#41">41</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.HTMLTranscoder;
<a name="42" href="#42">42</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.JSONTranscoder;
<a name="43" href="#43">43</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.Transcoder;
<a name="44" href="#44">44</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.XMLTranscoder;
<a name="45" href="#45">45</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBrokerManager;
<a name="46" href="#46">46</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityReference;
<a name="47" href="#47">47</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityView;
<a name="48" href="#48">48</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderManager;
<a name="49" href="#49">49</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.InputTranslatable;
<a name="50" href="#50">50</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Inputable;
<a name="51" href="#51">51</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.OutputFormattable;
<a name="52" href="#52">52</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.OutputSerializable;
<a name="53" href="#53">53</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Outputable;
<a name="54" href="#54">54</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.EntityData;
<a name="55" href="#55">55</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.Formats;
<a name="56" href="#56">56</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.search.Search;
<a name="57" href="#57">57</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.EntityEncodingException;
<a name="58" href="#58">58</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.EntityException;
<a name="59" href="#59">59</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.FormatUnsupportedException;
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>  <em>/**<em>*</em></em>
<a name="63" href="#63">63</a>  <em> * This handles the internal encoding (translation and formatting) of entity data,</em>
<a name="64" href="#64">64</a>  <em> * this can be used by various parts of the EB system &lt;br/></em>
<a name="65" href="#65">65</a>  <em> * this is for internal use only currently but may be exposed later</em>
<a name="66" href="#66">66</a>  <em> * </em>
<a name="67" href="#67">67</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="68" href="#68">68</a>  <em> */</em>
<a name="69" href="#69">69</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> {
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENTITY_REFERENCE = <span class="string">"entityReference"</span>;
<a name="72" href="#72">72</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENTITY_ID = <span class="string">"entityId"</span>;
<a name="73" href="#73">73</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENTITY_URL = <span class="string">"entityURL"</span>;
<a name="74" href="#74">74</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENTITY_TITLE = <span class="string">"entityTitle"</span>;
<a name="75" href="#75">75</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENTITY_PREFIX = <span class="string">"entityPrefix"</span>;
<a name="76" href="#76">76</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String COLLECTION = <span class="string">"_collection"</span>;
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(EntityEncodingManager.<strong>class</strong>);
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String[] HANDLED_INPUT_FORMATS = <strong>new</strong> String[] { Formats.XML, Formats.JSON, Formats.HTML };
<a name="81" href="#81">81</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String[] HANDLED_OUTPUT_FORMATS = <strong>new</strong> String[] { Formats.XML, Formats.JSON, Formats.HTML };
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>      <strong>protected</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a>() { }
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a>(EntityProviderManager entityProviderManager,
<a name="87" href="#87">87</a>              EntityBrokerManager entityBrokerManager) {
<a name="88" href="#88">88</a>          <strong>super</strong>();
<a name="89" href="#89">89</a>          <strong>this</strong>.entityProviderManager = entityProviderManager;
<a name="90" href="#90">90</a>          <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="91" href="#91">91</a>      }
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      <strong>private</strong> EntityProviderManager entityProviderManager;
<a name="94" href="#94">94</a>      <strong>public</strong> <strong>void</strong> setEntityProviderManager(EntityProviderManager entityProviderManager) {
<a name="95" href="#95">95</a>          <strong>this</strong>.entityProviderManager = entityProviderManager;
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <strong>private</strong> EntityBrokerManager entityBrokerManager;
<a name="99" href="#99">99</a>      <strong>public</strong> <strong>void</strong> setEntityBrokerManager(EntityBrokerManager entityBrokerManager) {
<a name="100" href="#100">100</a>         <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="101" href="#101">101</a>     }
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>     <em>/**<em>*</em></em>
<a name="105" href="#105">105</a> <em>     * Format and output an entity or collection included or referred to by this entity ref object</em>
<a name="106" href="#106">106</a> <em>     * into output according to the format string provided,</em>
<a name="107" href="#107">107</a> <em>     * Should take into account the reference when determining what the entities are</em>
<a name="108" href="#108">108</a> <em>     * and how to encode them</em>
<a name="109" href="#109">109</a> <em>     * (This is basically a copy of the code in EntityHandlerImpl with stuff removed)</em>
<a name="110" href="#110">110</a> <em>     * </em>
<a name="111" href="#111">111</a> <em>     * @param ref a globally unique reference to an entity, </em>
<a name="112" href="#112">112</a> <em>     * consists of the entity prefix and optional segments</em>
<a name="113" href="#113">113</a> <em>     * @param format a string constant indicating the format (from {@link Formats}) </em>
<a name="114" href="#114">114</a> <em>     * for output, (example: {@link #XML})</em>
<a name="115" href="#115">115</a> <em>     * @param entities (optional) a list of entities to create formatted output for,</em>
<a name="116" href="#116">116</a> <em>     * if this is null then the entities should be retrieved based on the reference,</em>
<a name="117" href="#117">117</a> <em>     * if this contains only a single item AND the ref refers to a single entity</em>
<a name="118" href="#118">118</a> <em>     * then the entity should be extracted from the list and encoded without the indication</em>
<a name="119" href="#119">119</a> <em>     * that it is a collection, for all other cases the encoding should include an indication that</em>
<a name="120" href="#120">120</a> <em>     * this is a list of entities</em>
<a name="121" href="#121">121</a> <em>     * @param outputStream the output stream to place the formatted data in,</em>
<a name="122" href="#122">122</a> <em>     * should be UTF-8 encoded if there is char data</em>
<a name="123" href="#123">123</a> <em>     * @throws FormatUnsupportedException if you do not handle this format type (passes control to the internal handlers)</em>
<a name="124" href="#124">124</a> <em>     * @throws EntityEncodingException if you cannot encode the received data into an entity</em>
<a name="125" href="#125">125</a> <em>     * @throws IllegalArgumentException if any of the arguments are invalid</em>
<a name="126" href="#126">126</a> <em>     * @throws IllegalStateException for all other failures</em>
<a name="127" href="#127">127</a> <em>     */</em>
<a name="128" href="#128">128</a>     <strong>public</strong> <strong>void</strong> formatAndOutputEntity(EntityReference ref, String format, List&lt;EntityData> entities, OutputStream outputStream, Map&lt;String, Object> params) {
<a name="129" href="#129">129</a>         <strong>if</strong> (ref == <strong>null</strong> || format == <strong>null</strong> || outputStream == <strong>null</strong>) {
<a name="130" href="#130">130</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"ref, format, and output cannot be null"</span>);
<a name="131" href="#131">131</a>         }
<a name="132" href="#132">132</a>         String prefix = ref.getPrefix();
<a name="133" href="#133">133</a>         Outputable outputable = (Outputable) entityProviderManager.getProviderByPrefixAndCapability(prefix, Outputable.<strong>class</strong>);
<a name="134" href="#134">134</a>         <strong>if</strong> (outputable != <strong>null</strong>) {
<a name="135" href="#135">135</a>             String[] outputFormats = outputable.getHandledOutputFormats();
<a name="136" href="#136">136</a>             <em class="comment">// check if the output formats are allowed</em>
<a name="137" href="#137">137</a>             <strong>if</strong> (outputFormats == <strong>null</strong> || ReflectUtils.contains(outputFormats, format) ) {
<a name="138" href="#138">138</a>                 <strong>boolean</strong> handled = false;
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>                 <em class="comment">// if the user wants to serialize their objects specially then allow them to translate them</em>
<a name="141" href="#141">141</a>                 OutputSerializable serializable = entityProviderManager.getProviderByPrefixAndCapability(prefix, OutputSerializable.<strong>class</strong>);
<a name="142" href="#142">142</a>                 <strong>if</strong> (serializable != <strong>null</strong>) {
<a name="143" href="#143">143</a>                     <strong>if</strong> (entities == <strong>null</strong>) {
<a name="144" href="#144">144</a>                         <em class="comment">// these will be EntityData</em>
<a name="145" href="#145">145</a>                         entities = entityBrokerManager.getEntitiesData(ref, <strong>new</strong> Search(), params);
<a name="146" href="#146">146</a>                     }
<a name="147" href="#147">147</a>                     <strong>if</strong> (! entities.isEmpty()) {
<a name="148" href="#148">148</a>                         <em class="comment">// find the type of the objects this providers deals in</em>
<a name="149" href="#149">149</a>                         Object sample = entityBrokerManager.getSampleEntityObject(prefix, <strong>null</strong>);
<a name="150" href="#150">150</a>                         Class&lt;?> entityType = Object.<strong>class</strong>;
<a name="151" href="#151">151</a>                         <strong>if</strong> (sample != <strong>null</strong>) {
<a name="152" href="#152">152</a>                             entityType = sample.getClass();
<a name="153" href="#153">153</a>                         }
<a name="154" href="#154">154</a>                         <em class="comment">// now translate the objects to serialize form</em>
<a name="155" href="#155">155</a>                         <strong>for</strong> (EntityData entityData : entities) {
<a name="156" href="#156">156</a>                             Object entity = entityData.getData();
<a name="157" href="#157">157</a>                             <em class="comment">// only translate if the entity is set</em>
<a name="158" href="#158">158</a>                             <strong>if</strong> (entity != <strong>null</strong>) {
<a name="159" href="#159">159</a>                                 <em class="comment">// only translate if the type matches</em>
<a name="160" href="#160">160</a>                                 <strong>if</strong> (entityType.isAssignableFrom(entity.getClass())) {
<a name="161" href="#161">161</a>                                     <strong>try</strong> {
<a name="162" href="#162">162</a>                                         entity = serializable.makeSerializableObject(ref, entity);
<a name="163" href="#163">163</a>                                         entityData.setData(entity);
<a name="164" href="#164">164</a>                                     } <strong>catch</strong> (Exception e) {
<a name="165" href="#165">165</a>                                         <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failure while attempting to serialize the object from ("</span>+entity+<span class="string">") for ref("</span>+ref+<span class="string">"): "</span> + e.getMessage(), e);
<a name="166" href="#166">166</a>                                     }
<a name="167" href="#167">167</a>                                 }
<a name="168" href="#168">168</a>                             }
<a name="169" href="#169">169</a>                         }
<a name="170" href="#170">170</a>                     }
<a name="171" href="#171">171</a>                 }
<a name="172" href="#172">172</a> 
<a name="173" href="#173">173</a>                 <em class="comment">/*<em class="comment"> try to use the provider formatter if one available,</em></em>
<a name="174" href="#174">174</a> <em class="comment">                 * if it decided not to handle it or none is available then control passes to internal</em>
<a name="175" href="#175">175</a> <em class="comment">                 */</em>
<a name="176" href="#176">176</a>                 <strong>try</strong> {
<a name="177" href="#177">177</a>                     OutputFormattable formattable = entityProviderManager.getProviderByPrefixAndCapability(prefix, OutputFormattable.<strong>class</strong>);
<a name="178" href="#178">178</a>                     <strong>if</strong> (formattable != <strong>null</strong>) {
<a name="179" href="#179">179</a>                         <em class="comment">// use provider's formatter</em>
<a name="180" href="#180">180</a>                         formattable.formatOutput(ref, format, entities, params, outputStream);
<a name="181" href="#181">181</a>                         handled = <strong>true</strong>;
<a name="182" href="#182">182</a>                     }
<a name="183" href="#183">183</a>                 } <strong>catch</strong> (FormatUnsupportedException e) {
<a name="184" href="#184">184</a>                     <em class="comment">// provider decided not to handle this format</em>
<a name="185" href="#185">185</a>                     handled = false;
<a name="186" href="#186">186</a>                 }
<a name="187" href="#187">187</a>                 <strong>if</strong> (!handled) {
<a name="188" href="#188">188</a>                     <em class="comment">// handle internally or fail</em>
<a name="189" href="#189">189</a>                     internalOutputFormatter(ref, format, entities, params, outputStream, <strong>null</strong>);
<a name="190" href="#190">190</a>                 }
<a name="191" href="#191">191</a>             } <strong>else</strong> {
<a name="192" href="#192">192</a>                 <em class="comment">// format type not handled</em>
<a name="193" href="#193">193</a>                 <strong>throw</strong> <strong>new</strong> FormatUnsupportedException(<span class="string">"Outputable restriction for "</span> 
<a name="194" href="#194">194</a>                         + prefix + <span class="string">" blocked handling this format ("</span>+format+<span class="string">")"</span>,
<a name="195" href="#195">195</a>                         ref+<span class="string">""</span>, format);
<a name="196" href="#196">196</a>             }
<a name="197" href="#197">197</a>         }
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <em>/**<em>*</em></em>
<a name="201" href="#201">201</a> <em>     * Translates the input data stream in the supplied format into an entity object for this reference</em>
<a name="202" href="#202">202</a> <em>     * (This is basically a copy of the code in EntityHandlerImpl with stuff removed)</em>
<a name="203" href="#203">203</a> <em>     * </em>
<a name="204" href="#204">204</a> <em>     * @param ref a globally unique reference to an entity, </em>
<a name="205" href="#205">205</a> <em>     * consists of the entity prefix and optional segments</em>
<a name="206" href="#206">206</a> <em>     * @param format a string constant indicating the format (from {@link Formats}) </em>
<a name="207" href="#207">207</a> <em>     * of the input, (example: {@link #XML})</em>
<a name="208" href="#208">208</a> <em>     * @param input a stream which contains the data to make up this entity,</em>
<a name="209" href="#209">209</a> <em>     * you may assume this is UTF-8 encoded if you don't know anything else about it</em>
<a name="210" href="#210">210</a> <em>     * @return an entity object of the type used for the given reference</em>
<a name="211" href="#211">211</a> <em>     * @throws FormatUnsupportedException if you do not handle this format type (passes control to the internal handlers)</em>
<a name="212" href="#212">212</a> <em>     * @throws EntityEncodingException if you cannot encode the received data into an entity</em>
<a name="213" href="#213">213</a> <em>     * @throws IllegalArgumentException if any of the arguments are invalid</em>
<a name="214" href="#214">214</a> <em>     * @throws IllegalStateException for all other failures</em>
<a name="215" href="#215">215</a> <em>     */</em>
<a name="216" href="#216">216</a>     <strong>public</strong> Object translateInputToEntity(EntityReference ref, String format, InputStream inputStream, Map&lt;String, Object> params) {
<a name="217" href="#217">217</a>         <strong>if</strong> (ref == <strong>null</strong> || format == <strong>null</strong> || inputStream == <strong>null</strong>) {
<a name="218" href="#218">218</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"ref, format, and inputStream cannot be null"</span>);
<a name="219" href="#219">219</a>         }
<a name="220" href="#220">220</a>         Object entity = <strong>null</strong>;
<a name="221" href="#221">221</a>         String prefix = ref.getPrefix();
<a name="222" href="#222">222</a>         Inputable inputable = (Inputable) entityProviderManager.getProviderByPrefixAndCapability(prefix, Inputable.<strong>class</strong>);
<a name="223" href="#223">223</a>         <strong>if</strong> (inputable != <strong>null</strong>) {
<a name="224" href="#224">224</a>             String[] inputFormats = inputable.getHandledInputFormats();
<a name="225" href="#225">225</a>             <strong>if</strong> (inputFormats == <strong>null</strong> || ReflectUtils.contains(inputFormats, format) ) {
<a name="226" href="#226">226</a>                 <strong>boolean</strong> handled = false;
<a name="227" href="#227">227</a>                 <em class="comment">/*<em class="comment"> try to use the provider translator if one available,</em></em>
<a name="228" href="#228">228</a> <em class="comment">                 * if it decided not to handle it or none is available then control passes to internal</em>
<a name="229" href="#229">229</a> <em class="comment">                 */</em>
<a name="230" href="#230">230</a>                 <strong>try</strong> {
<a name="231" href="#231">231</a>                     InputTranslatable translatable = (InputTranslatable) entityProviderManager.getProviderByPrefixAndCapability(prefix, InputTranslatable.<strong>class</strong>);
<a name="232" href="#232">232</a>                     <strong>if</strong> (translatable != <strong>null</strong>) {
<a name="233" href="#233">233</a>                         <em class="comment">// use provider's translator</em>
<a name="234" href="#234">234</a>                         entity = translatable.translateFormattedData(ref, format, inputStream, params);
<a name="235" href="#235">235</a>                         handled = <strong>true</strong>;
<a name="236" href="#236">236</a>                     }
<a name="237" href="#237">237</a>                 } <strong>catch</strong> (FormatUnsupportedException e) {
<a name="238" href="#238">238</a>                     <em class="comment">// provider decided not to handle this format</em>
<a name="239" href="#239">239</a>                     handled = false;
<a name="240" href="#240">240</a>                 }
<a name="241" href="#241">241</a>                 <strong>if</strong> (!handled) {
<a name="242" href="#242">242</a>                     <em class="comment">// use internal translators or fail</em>
<a name="243" href="#243">243</a>                     entity = internalInputTranslator(ref, format, inputStream, <strong>null</strong>);
<a name="244" href="#244">244</a>                 }
<a name="245" href="#245">245</a> 
<a name="246" href="#246">246</a>                 <strong>if</strong> (entity == <strong>null</strong>) {
<a name="247" href="#247">247</a>                     <em class="comment">// FAILURE input could not be translated into an entity object</em>
<a name="248" href="#248">248</a>                     <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Unable to translate entity ("</span>+ref+<span class="string">") with format ("</span>
<a name="249" href="#249">249</a>                             +format+<span class="string">"), translated entity object was null"</span>, ref+<span class="string">""</span>);
<a name="250" href="#250">250</a>                 }
<a name="251" href="#251">251</a>             } <strong>else</strong> {
<a name="252" href="#252">252</a>                 <em class="comment">// format type not handled</em>
<a name="253" href="#253">253</a>                 <strong>throw</strong> <strong>new</strong> FormatUnsupportedException(<span class="string">"Inputable restriction for "</span> 
<a name="254" href="#254">254</a>                         + prefix + <span class="string">" blocked handling this format ("</span>+format+<span class="string">")"</span>,
<a name="255" href="#255">255</a>                         ref+<span class="string">""</span>, format);
<a name="256" href="#256">256</a>             }
<a name="257" href="#257">257</a>         }
<a name="258" href="#258">258</a>         <strong>return</strong> entity;
<a name="259" href="#259">259</a>     }
<a name="260" href="#260">260</a> 
<a name="261" href="#261">261</a>     <em>/**<em>*</em></em>
<a name="262" href="#262">262</a> <em>     * Will attempt to validate that string data is of a specific format</em>
<a name="263" href="#263">263</a> <em>     * @param data a chunk of data to validate</em>
<a name="264" href="#264">264</a> <em>     * @param format the format which the data is supposed encoded in</em>
<a name="265" href="#265">265</a> <em>     * @return true if the data appears valid for the given format, false otherwise</em>
<a name="266" href="#266">266</a> <em>     */</em>
<a name="267" href="#267">267</a>     <strong>public</strong> <strong>boolean</strong> validateFormat(String data, String format) {
<a name="268" href="#268">268</a>         <em class="comment">// note: this is a weak implementation for now -AZ</em>
<a name="269" href="#269">269</a>         <strong>boolean</strong> valid = false;
<a name="270" href="#270">270</a>         <strong>if</strong> (data == <strong>null</strong> || format == <strong>null</strong>) {
<a name="271" href="#271">271</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot validate format when the data ("</span>+data+<span class="string">") OR the format ("</span>+format+<span class="string">") are null"</span>);
<a name="272" href="#272">272</a>         }
<a name="273" href="#273">273</a>         data = data.trim();
<a name="274" href="#274">274</a>         <strong>if</strong> (Formats.XML.equals(format)) {
<a name="275" href="#275">275</a>             <strong>if</strong> (data.startsWith(<span class="string">"&lt;"</span>) &amp;&amp; data.endsWith(<span class="string">">"</span>)) {
<a name="276" href="#276">276</a>                 valid = <strong>true</strong>;
<a name="277" href="#277">277</a>             }
<a name="278" href="#278">278</a>         } <strong>else</strong> <strong>if</strong> (Formats.JSON.equals(format)) {
<a name="279" href="#279">279</a>             <strong>if</strong> (data.startsWith(<span class="string">"{"</span>) &amp;&amp; data.endsWith(<span class="string">"}"</span>)) {
<a name="280" href="#280">280</a>                 valid = <strong>true</strong>;
<a name="281" href="#281">281</a>             }
<a name="282" href="#282">282</a>         } <strong>else</strong> <strong>if</strong> (Formats.HTML.equals(format)) {
<a name="283" href="#283">283</a>             <strong>if</strong> (data.startsWith(<span class="string">"&lt;"</span>) &amp;&amp; data.endsWith(<span class="string">">"</span>)) {
<a name="284" href="#284">284</a>                 valid = <strong>true</strong>;
<a name="285" href="#285">285</a>             }
<a name="286" href="#286">286</a>         } <strong>else</strong> {
<a name="287" href="#287">287</a>             valid = <strong>true</strong>;
<a name="288" href="#288">288</a>         }
<a name="289" href="#289">289</a>         <strong>return</strong> valid;
<a name="290" href="#290">290</a>     }
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a> 
<a name="293" href="#293">293</a>     <em class="comment">// FUNCTIONAL CODE BELOW</em>
<a name="294" href="#294">294</a> 
<a name="295" href="#295">295</a>     <em>/**<em>*</em></em>
<a name="296" href="#296">296</a> <em>     * Handled the internal encoding of data into an entity object</em>
<a name="297" href="#297">297</a> <em>     * </em>
<a name="298" href="#298">298</a> <em>     * @param ref the entity reference</em>
<a name="299" href="#299">299</a> <em>     * @param format the format which the input is encoded in</em>
<a name="300" href="#300">300</a> <em>     * @param input the data being input</em>
<a name="301" href="#301">301</a> <em>     * @return the entity object based on the data</em>
<a name="302" href="#302">302</a> <em>     * @throws FormatUnsupportedException if you do not handle this format type (passes control to the internal handlers)</em>
<a name="303" href="#303">303</a> <em>     * @throws EntityEncodingException if you cannot encode the received data into an entity</em>
<a name="304" href="#304">304</a> <em>     * @throws IllegalArgumentException if any of the arguments are invalid</em>
<a name="305" href="#305">305</a> <em>     * @throws IllegalStateException for all other failures</em>
<a name="306" href="#306">306</a> <em>     */</em>
<a name="307" href="#307">307</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="308" href="#308">308</a>     <strong>public</strong> Object internalInputTranslator(EntityReference ref, String format, InputStream input, HttpServletRequest req) {
<a name="309" href="#309">309</a>         Object entity = <strong>null</strong>;
<a name="310" href="#310">310</a> 
<a name="311" href="#311">311</a>         Inputable inputable = entityProviderManager.getProviderByPrefixAndCapability(ref.getPrefix(), Inputable.<strong>class</strong>);
<a name="312" href="#312">312</a>         <strong>if</strong> (inputable != <strong>null</strong>) {
<a name="313" href="#313">313</a>             <em class="comment">// get a the current entity object or a sample</em>
<a name="314" href="#314">314</a>             Object current = entityBrokerManager.getSampleEntityObject(ref.getPrefix(), ref.getId());
<a name="315" href="#315">315</a>             <strong>if</strong> (current != <strong>null</strong>) {
<a name="316" href="#316">316</a>                 <strong>if</strong> (Formats.HTML.equals(format) || format == <strong>null</strong> || <span class="string">""</span>.equals(format)) {
<a name="317" href="#317">317</a>                     <em class="comment">// html req handled specially</em>
<a name="318" href="#318">318</a>                     <strong>if</strong> (req != <strong>null</strong>) {
<a name="319" href="#319">319</a>                         Map&lt;String, String[]> params = req.getParameterMap();
<a name="320" href="#320">320</a>                         <strong>if</strong> (params != <strong>null</strong> &amp;&amp; params.size() > 0) {
<a name="321" href="#321">321</a>                             entity = current;
<a name="322" href="#322">322</a>                             <strong>try</strong> {
<a name="323" href="#323">323</a>                                 ReflectUtils.getInstance().populateFromParams(entity, params);
<a name="324" href="#324">324</a>                             } <strong>catch</strong> (RuntimeException e) {
<a name="325" href="#325">325</a>                                 <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Unable to populate bean for ref ("</span>+ref+<span class="string">") from request: "</span> + e.getMessage(), ref+<span class="string">""</span>, e);
<a name="326" href="#326">326</a>                             }
<a name="327" href="#327">327</a>                         } <strong>else</strong> {
<a name="328" href="#328">328</a>                             <em class="comment">// no request params, bad request</em>
<a name="329" href="#329">329</a>                             <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"No request params for html input request (there must be at least one) for reference: "</span> + ref, 
<a name="330" href="#330">330</a>                                     ref.toString(), HttpServletResponse.SC_BAD_REQUEST);
<a name="331" href="#331">331</a>                         }
<a name="332" href="#332">332</a>                     }
<a name="333" href="#333">333</a>                 } <strong>else</strong> {
<a name="334" href="#334">334</a>                     <em class="comment">// all other formats</em>
<a name="335" href="#335">335</a>                     <strong>if</strong> (input == <strong>null</strong>) {
<a name="336" href="#336">336</a>                         <em class="comment">// no request params, bad request</em>
<a name="337" href="#337">337</a>                         <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"No input for input translation (input cannot be null) for reference: "</span> + ref, 
<a name="338" href="#338">338</a>                                 ref.toString(), HttpServletResponse.SC_BAD_REQUEST);
<a name="339" href="#339">339</a>                     } <strong>else</strong> {
<a name="340" href="#340">340</a>                         String data = StringUtils.makeStringFromInputStream(input);
<a name="341" href="#341">341</a>                         Map&lt;String, Object> decoded = <strong>null</strong>;
<a name="342" href="#342">342</a>                         <strong>try</strong> {
<a name="343" href="#343">343</a>                             decoded = decodeData(data, format);
<a name="344" href="#344">344</a>                         } <strong>catch</strong> (IllegalArgumentException iae) {
<a name="345" href="#345">345</a>                             <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"No encoder available for the given format ("</span>+format+<span class="string">"), ref="</span> + ref + <span class="string">":"</span> + iae.getMessage(), ref.toString(), iae);
<a name="346" href="#346">346</a>                         } <strong>catch</strong> (UnsupportedOperationException uoe) {
<a name="347" href="#347">347</a>                             <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Failure during internal input encoding of entity: "</span> + ref + <span class="string">" to format ("</span>+format+<span class="string">"):"</span> + uoe.getMessage(), ref.toString(), uoe);
<a name="348" href="#348">348</a>                         }
<a name="349" href="#349">349</a>                         entity = current;
<a name="350" href="#350">350</a>                         <em class="comment">// handle the special case where the JSON was created by xstream or something else that puts the data inside an object with a "root"</em>
<a name="351" href="#351">351</a>                         <strong>if</strong> (decoded.size() == 1 &amp;&amp; decoded.containsKey(ref.getPrefix())) {
<a name="352" href="#352">352</a>                             Object o = decoded.get(ref.getPrefix());
<a name="353" href="#353">353</a>                             <strong>if</strong> (o instanceof Map) {
<a name="354" href="#354">354</a>                                 decoded = (Map&lt;String, Object>) o;
<a name="355" href="#355">355</a>                             }
<a name="356" href="#356">356</a>                         }
<a name="357" href="#357">357</a>                         <strong>try</strong> {
<a name="358" href="#358">358</a>                             ReflectUtils.getInstance().populate(entity, decoded);
<a name="359" href="#359">359</a>                         } <strong>catch</strong> (RuntimeException e) {
<a name="360" href="#360">360</a>                             <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Unable to populate bean for ref ("</span>+ref+<span class="string">") from data: "</span> + decoded + <span class="string">":"</span> + e.getMessage(), ref+<span class="string">""</span>, e);
<a name="361" href="#361">361</a>                         }
<a name="362" href="#362">362</a>                     }
<a name="363" href="#363">363</a>                 }
<a name="364" href="#364">364</a>             }
<a name="365" href="#365">365</a>         } <strong>else</strong> {
<a name="366" href="#366">366</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"This entity ("</span>+ref+<span class="string">") does not allow input translation"</span>);
<a name="367" href="#367">367</a>         }
<a name="368" href="#368">368</a>         <strong>if</strong> (entity == <strong>null</strong>) {
<a name="369" href="#369">369</a>             <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to encode entity from input for reference: "</span> + ref, ref.toString(), HttpServletResponse.SC_BAD_REQUEST);
<a name="370" href="#370">370</a>         }
<a name="371" href="#371">371</a>         <strong>return</strong> entity;
<a name="372" href="#372">372</a>     }
<a name="373" href="#373">373</a> 
<a name="374" href="#374">374</a> 
<a name="375" href="#375">375</a>     <em>/**<em>*</em></em>
<a name="376" href="#376">376</a> <em>     * Format entities for output based on the reference into a format,</em>
<a name="377" href="#377">377</a> <em>     * use the provided list or get the entities</em>
<a name="378" href="#378">378</a> <em>     * </em>
<a name="379" href="#379">379</a> <em>     * @param ref the entity reference for this, </em>
<a name="380" href="#380">380</a> <em>     * if this is a reference to a collection then this will be rendered as a collection of entities,</em>
<a name="381" href="#381">381</a> <em>     * if a reference to a single entity then only the matching one from the collection will be used</em>
<a name="382" href="#382">382</a> <em>     * @param format the format to use for the output data</em>
<a name="383" href="#383">383</a> <em>     * @param entities (optional) if this is null then the entities will be fetched</em>
<a name="384" href="#384">384</a> <em>     * @param output the outputstream to place the encoded data into</em>
<a name="385" href="#385">385</a> <em>     * @param view (optional) </em>
<a name="386" href="#386">386</a> <em>     * @throws FormatUnsupportedException if you do not handle this format type (passes control to the internal handlers)</em>
<a name="387" href="#387">387</a> <em>     * @throws EntityEncodingException if you cannot encode the received data into an entity</em>
<a name="388" href="#388">388</a> <em>     * @throws IllegalArgumentException if any of the arguments are invalid</em>
<a name="389" href="#389">389</a> <em>     * @throws IllegalStateException for all other failures</em>
<a name="390" href="#390">390</a> <em>     */</em>
<a name="391" href="#391">391</a>     <strong>public</strong> <strong>void</strong> internalOutputFormatter(EntityReference ref, String format, List&lt;EntityData> entities, Map&lt;String, Object> params, OutputStream output, EntityView view) {
<a name="392" href="#392">392</a>         <strong>if</strong> (format == <strong>null</strong>) { format = Outputable.HTML; }
<a name="393" href="#393">393</a> 
<a name="394" href="#394">394</a>         <em class="comment">// check the format to see if we can handle it</em>
<a name="395" href="#395">395</a>         <strong>if</strong> (! ReflectUtils.contains(HANDLED_OUTPUT_FORMATS, format)) {
<a name="396" href="#396">396</a>             <strong>throw</strong> <strong>new</strong> FormatUnsupportedException(<span class="string">"Internal output formatter cannot handle format ("</span>+format+<span class="string">") for ref ("</span>+ref+<span class="string">")"</span>, ref+<span class="string">""</span>, format);
<a name="397" href="#397">397</a>         }
<a name="398" href="#398">398</a> 
<a name="399" href="#399">399</a>         <strong>if</strong> (view == <strong>null</strong>) {
<a name="400" href="#400">400</a>             view = entityBrokerManager.makeEntityView(ref, <strong>null</strong>, <strong>null</strong>);
<a name="401" href="#401">401</a>         }
<a name="402" href="#402">402</a> 
<a name="403" href="#403">403</a>         <em class="comment">// get the entities if not supplied</em>
<a name="404" href="#404">404</a>         <strong>if</strong> (entities == <strong>null</strong>) {
<a name="405" href="#405">405</a>             <em class="comment">// these will be EntityData</em>
<a name="406" href="#406">406</a>             entities = entityBrokerManager.getEntitiesData(ref, <strong>new</strong> Search(), params);
<a name="407" href="#407">407</a>         }
<a name="408" href="#408">408</a>         <strong>if</strong> (entities.isEmpty()) {
<a name="409" href="#409">409</a>             <em class="comment">// just log this for now</em>
<a name="410" href="#410">410</a>             log.info(<span class="string">"No entities to format ("</span>+format+<span class="string">") and output for ref ("</span> + ref + <span class="string">")"</span>);
<a name="411" href="#411">411</a>         }
<a name="412" href="#412">412</a> 
<a name="413" href="#413">413</a>         String encoded = <strong>null</strong>;
<a name="414" href="#414">414</a>         <strong>if</strong> (EntityView.VIEW_LIST.equals(view.getViewKey()) 
<a name="415" href="#415">415</a>                 || ref.getId() == <strong>null</strong>) {
<a name="416" href="#416">416</a>             <em class="comment">// encoding a collection of entities</em>
<a name="417" href="#417">417</a>             StringBuilder sb = <strong>new</strong> StringBuilder(40);
<a name="418" href="#418">418</a> 
<a name="419" href="#419">419</a>             <em class="comment">// make header</em>
<a name="420" href="#420">420</a>             <strong>if</strong> (Formats.HTML.equals(format)) {
<a name="421" href="#421">421</a>                 sb.append(<span class="string">"&lt;h1>"</span>+ref.getPrefix() + COLLECTION + <span class="string">"&lt;/h1>\n"</span>);
<a name="422" href="#422">422</a>             } <strong>else</strong> <strong>if</strong> (Formats.JSON.equals(format)) {
<a name="423" href="#423">423</a>                 sb.append(<span class="string">"{\&quot;"</span>+ENTITY_PREFIX+<span class="string">"\&quot;: \&quot;"</span>+ref.getPrefix() + <span class="string">"\&quot;, \&quot;"</span> + ref.getPrefix() + COLLECTION + <span class="string">"\&quot;: [\n"</span>);
<a name="424" href="#424">424</a>             } <strong>else</strong> <strong>if</strong> (Formats.XML.equals(format)) {
<a name="425" href="#425">425</a>                 sb.append(<span class="string">"&lt;"</span> + ref.getPrefix() + COLLECTION + <span class="string">" "</span> + ENTITY_PREFIX + <span class="string">"=\&quot;"</span> + ref.getPrefix() + <span class="string">"\&quot;>\n"</span>);
<a name="426" href="#426">426</a>             } <strong>else</strong> { <em class="comment">// general case</em>
<a name="427" href="#427">427</a>                 sb.append(ref.getPrefix() + COLLECTION + <span class="string">"\n"</span>);
<a name="428" href="#428">428</a>             }
<a name="429" href="#429">429</a> 
<a name="430" href="#430">430</a>             <em class="comment">// loop through and encode items</em>
<a name="431" href="#431">431</a>             <strong>int</strong> encodedEntities = 0;
<a name="432" href="#432">432</a>             <strong>for</strong> (EntityData entity : entities) {
<a name="433" href="#433">433</a>                 <strong>try</strong> {
<a name="434" href="#434">434</a>                     String encode = encodeEntity(ref.getPrefix(), format, entity);
<a name="435" href="#435">435</a>                     <strong>if</strong> (encode.length() > 3) {
<a name="436" href="#436">436</a>                         <strong>if</strong> (Formats.JSON.equals(format) 
<a name="437" href="#437">437</a>                                 &amp;&amp; encodedEntities > 0) {
<a name="438" href="#438">438</a>                             sb.append(<span class="string">","</span>);
<a name="439" href="#439">439</a>                         }
<a name="440" href="#440">440</a>                         sb.append(encode);                     
<a name="441" href="#441">441</a>                         encodedEntities++;
<a name="442" href="#442">442</a>                     }
<a name="443" href="#443">443</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="444" href="#444">444</a>                     <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Failure during internal output encoding of entity set on entity: "</span> + ref, ref.toString(), e);
<a name="445" href="#445">445</a>                 }
<a name="446" href="#446">446</a>             }
<a name="447" href="#447">447</a> 
<a name="448" href="#448">448</a>             <em class="comment">// make footer</em>
<a name="449" href="#449">449</a>             <strong>if</strong> (Formats.HTML.equals(format)) {
<a name="450" href="#450">450</a>                 sb.append(<span class="string">"\n&lt;b>Collection size:&lt;/b> "</span>+encodedEntities+<span class="string">"\n"</span>);
<a name="451" href="#451">451</a>             } <strong>else</strong> <strong>if</strong> (Formats.JSON.equals(format)) {
<a name="452" href="#452">452</a>                 sb.append(<span class="string">"\n]}"</span>);
<a name="453" href="#453">453</a>             } <strong>else</strong> <strong>if</strong> (Formats.XML.equals(format)) {
<a name="454" href="#454">454</a>                 sb.append(<span class="string">"&lt;/"</span> + ref.getPrefix() + COLLECTION + <span class="string">">"</span>);
<a name="455" href="#455">455</a>             } <strong>else</strong> { <em class="comment">// general case</em>
<a name="456" href="#456">456</a>                 sb.append(<span class="string">"\nSize: "</span> + encodedEntities + <span class="string">"\n"</span>);
<a name="457" href="#457">457</a>             }
<a name="458" href="#458">458</a>             encoded = sb.toString();
<a name="459" href="#459">459</a>         } <strong>else</strong> {
<a name="460" href="#460">460</a>             <em class="comment">// encoding a single entity</em>
<a name="461" href="#461">461</a>             EntityData toEncode = entities.get(0);
<a name="462" href="#462">462</a>             <strong>if</strong> (toEncode == <strong>null</strong>) {
<a name="463" href="#463">463</a>                 <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Failed to encode data for entity ("</span> + ref 
<a name="464" href="#464">464</a>                         + <span class="string">"), entity object to encode could not be found (null object in list)"</span>, ref.toString());
<a name="465" href="#465">465</a>             } <strong>else</strong> {
<a name="466" href="#466">466</a>                 <strong>try</strong> {
<a name="467" href="#467">467</a>                     encoded = encodeEntity(ref.getPrefix(), format, toEncode);
<a name="468" href="#468">468</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="469" href="#469">469</a>                     <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Failure during internal output encoding of entity: "</span> + ref, ref.toString(), e);
<a name="470" href="#470">470</a>                 }
<a name="471" href="#471">471</a>             }
<a name="472" href="#472">472</a>         }
<a name="473" href="#473">473</a>         <em class="comment">// put the encoded data into the stream</em>
<a name="474" href="#474">474</a>         <strong>try</strong> {
<a name="475" href="#475">475</a>             byte[] b = encoded.getBytes(Formats.UTF_8);
<a name="476" href="#476">476</a>             output.write(b);
<a name="477" href="#477">477</a>         } <strong>catch</strong> (UnsupportedEncodingException e) {
<a name="478" href="#478">478</a>             <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Failed to encode UTF-8: "</span> + ref, ref.toString(), e);
<a name="479" href="#479">479</a>         } <strong>catch</strong> (IOException e) {
<a name="480" href="#480">480</a>             <strong>throw</strong> <strong>new</strong> EntityEncodingException(<span class="string">"Failed to encode into output stream: "</span> + ref, ref.toString(), e);
<a name="481" href="#481">481</a>         }
<a name="482" href="#482">482</a>     }
<a name="483" href="#483">483</a> 
<a name="484" href="#484">484</a> 
<a name="485" href="#485">485</a>     <em>/**<em>*</em></em>
<a name="486" href="#486">486</a> <em>     * Encodes entity data</em>
<a name="487" href="#487">487</a> <em>     * @param prefix the entity prefix related to this data</em>
<a name="488" href="#488">488</a> <em>     * @param format the format to encode the data into</em>
<a name="489" href="#489">489</a> <em>     * @param entityData entity data to encode</em>
<a name="490" href="#490">490</a> <em>     * @return the encoded entity or "" if encoding fails</em>
<a name="491" href="#491">491</a> <em>     */</em>
<a name="492" href="#492">492</a>     <strong>public</strong> String encodeEntity(String prefix, String format, EntityData entityData) {
<a name="493" href="#493">493</a>         <strong>if</strong> (prefix == <strong>null</strong> || format == <strong>null</strong> || entityData == <strong>null</strong>) {
<a name="494" href="#494">494</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"prefix, format, and entity data to encode must not be null"</span>);
<a name="495" href="#495">495</a>         }
<a name="496" href="#496">496</a>         String encoded = <span class="string">""</span>;
<a name="497" href="#497">497</a>         <strong>if</strong> (Formats.HTML.equals(format)) {
<a name="498" href="#498">498</a>             <em class="comment">// special handling for HTML</em>
<a name="499" href="#499">499</a>             StringBuilder sb = <strong>new</strong> StringBuilder(200);
<a name="500" href="#500">500</a>             sb.append(<span class="string">"  &lt;div style='padding-left:1em;'>\n"</span>);
<a name="501" href="#501">501</a>             sb.append(<span class="string">"    &lt;div style='font-weight:bold;'>"</span>+entityData.getDisplayTitle()+<span class="string">"&lt;/div>\n"</span>);
<a name="502" href="#502">502</a>             sb.append(<span class="string">"    &lt;table border='1'>\n"</span>);
<a name="503" href="#503">503</a>             sb.append(<span class="string">"      &lt;caption style='font-weight:bold;'>Entity Data&lt;/caption>\n"</span>);
<a name="504" href="#504">504</a>             <strong>if</strong> (! entityData.isDataOnly()) {
<a name="505" href="#505">505</a>                 sb.append(<span class="string">"      &lt;tr>&lt;td>entityReference&lt;/td>&lt;td>"</span>+entityData.getEntityReference()+<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="506" href="#506">506</a>                 sb.append(<span class="string">"      &lt;tr>&lt;td>entityURL&lt;/td>&lt;td>"</span>+entityData.getEntityURL()+<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="507" href="#507">507</a>                 <strong>if</strong> (entityData.getEntityRef() != <strong>null</strong>) {
<a name="508" href="#508">508</a>                     sb.append(<span class="string">"      &lt;tr>&lt;td>entityPrefix&lt;/td>&lt;td>"</span>+entityData.getEntityRef().getPrefix()+<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="509" href="#509">509</a>                     <strong>if</strong> (entityData.getEntityRef().getId() != <strong>null</strong>) {
<a name="510" href="#510">510</a>                         sb.append(<span class="string">"      &lt;tr>&lt;td>entityID&lt;/td>&lt;td>"</span>+entityData.getEntityRef().getId()+<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="511" href="#511">511</a>                     }
<a name="512" href="#512">512</a>                 }
<a name="513" href="#513">513</a>             }
<a name="514" href="#514">514</a>             <strong>if</strong> (entityData.getData() != <strong>null</strong>) {
<a name="515" href="#515">515</a>                 sb.append(<span class="string">"      &lt;tr>&lt;td>entity-type&lt;/td>&lt;td>"</span>+entityData.getData().getClass().getName()+<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="516" href="#516">516</a>                 <em class="comment">// dump entity data</em>
<a name="517" href="#517">517</a>                 sb.append(<span class="string">"      &lt;tr>&lt;td colspan='2'>Data:&lt;br/>\n"</span>);
<a name="518" href="#518">518</a>                 sb.append( encodeData(entityData.getData(), Formats.HTML, <strong>null</strong>, <strong>null</strong>) );
<a name="519" href="#519">519</a>                 sb.append(<span class="string">"      &lt;/td>&lt;/tr>\n"</span>);
<a name="520" href="#520">520</a>             } <strong>else</strong> {
<a name="521" href="#521">521</a>                 sb.append(<span class="string">"      &lt;tr>&lt;td>entity-object&lt;/td>&lt;td>&lt;i>null&lt;/i>&lt;/td>&lt;/tr>\n"</span>);
<a name="522" href="#522">522</a>             }
<a name="523" href="#523">523</a>             sb.append(<span class="string">"    &lt;/table>\n"</span>);
<a name="524" href="#524">524</a>             Map&lt;String, Object> props = entityData.getEntityProperties();
<a name="525" href="#525">525</a>             <strong>if</strong> (!props.isEmpty()) {
<a name="526" href="#526">526</a>                 sb.append(<span class="string">"    &lt;table border='1'>\n"</span>);
<a name="527" href="#527">527</a>                 sb.append(<span class="string">"      &lt;caption style='font-weight:bold;'>Properties&lt;/caption>\n"</span>);
<a name="528" href="#528">528</a>                 <strong>for</strong> (Entry&lt;String, Object> entry : props.entrySet()) {
<a name="529" href="#529">529</a>                     sb.append(<span class="string">"      &lt;tr>&lt;td>"</span>+entry.getKey()+<span class="string">"&lt;/td>&lt;td>"</span>+entry.getValue()+<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="530" href="#530">530</a>                 }
<a name="531" href="#531">531</a>                 sb.append(<span class="string">"    &lt;/table>\n"</span>);
<a name="532" href="#532">532</a>             }
<a name="533" href="#533">533</a>             sb.append(<span class="string">"  &lt;/div>\n"</span>);
<a name="534" href="#534">534</a>             encoded = sb.toString();
<a name="535" href="#535">535</a>         } <strong>else</strong> {
<a name="536" href="#536">536</a>             <em class="comment">// encode the entity itself</em>
<a name="537" href="#537">537</a>             Object toEncode = entityData; <em class="comment">// default to encoding the entity data object</em>
<a name="538" href="#538">538</a>             Map&lt;String, Object> entityProps = <strong>new</strong> ArrayOrderedMap&lt;String, Object>();
<a name="539" href="#539">539</a>             <strong>if</strong> (entityData.getData() != <strong>null</strong>) {
<a name="540" href="#540">540</a>                 <strong>if</strong> (entityData.isDataOnly()) {
<a name="541" href="#541">541</a>                     toEncode = entityData.getData();
<a name="542" href="#542">542</a>                     <em class="comment">// no meta data except properties if there are any</em>
<a name="543" href="#543">543</a>                     entityProps.putAll( entityData.getEntityProperties() );
<a name="544" href="#544">544</a>                 } <strong>else</strong> {
<a name="545" href="#545">545</a>                     <strong>if</strong> (ConstructorUtils.isClassBean(entityData.getData().getClass())) {
<a name="546" href="#546">546</a>                         <em class="comment">// encode the bean directly if it is one</em>
<a name="547" href="#547">547</a>                         toEncode = entityData.getData();
<a name="548" href="#548">548</a>                         <em class="comment">// add in the extra props</em>
<a name="549" href="#549">549</a>                         entityProps.put(ENTITY_REFERENCE, entityData.getEntityReference());
<a name="550" href="#550">550</a>                         entityProps.put(ENTITY_URL, entityData.getEntityURL());
<a name="551" href="#551">551</a>                         <strong>if</strong> (entityData.getEntityRef().getId() != <strong>null</strong>) {
<a name="552" href="#552">552</a>                             entityProps.put(ENTITY_ID, entityData.getEntityRef().getId());
<a name="553" href="#553">553</a>                         }
<a name="554" href="#554">554</a>                         <strong>if</strong> (entityData.isDisplayTitleSet()) {
<a name="555" href="#555">555</a>                             entityProps.put(ENTITY_TITLE, entityData.getDisplayTitle());
<a name="556" href="#556">556</a>                         }
<a name="557" href="#557">557</a>                     }
<a name="558" href="#558">558</a>                 }
<a name="559" href="#559">559</a>             }
<a name="560" href="#560">560</a>             <em class="comment">// do the encoding</em>
<a name="561" href="#561">561</a>             <strong>try</strong> {
<a name="562" href="#562">562</a>                 encoded = encodeData(toEncode, format, prefix, entityProps);
<a name="563" href="#563">563</a>             } <strong>catch</strong> (IllegalArgumentException e) {
<a name="564" href="#564">564</a>                 <em class="comment">// no transcoder so just toString this and dump it out</em>
<a name="565" href="#565">565</a>                 encoded = prefix + <span class="string">" : "</span> + entityData;
<a name="566" href="#566">566</a>             }
<a name="567" href="#567">567</a>         }
<a name="568" href="#568">568</a>         <strong>return</strong> encoded;
<a name="569" href="#569">569</a>     }
<a name="570" href="#570">570</a> 
<a name="571" href="#571">571</a>     <strong>protected</strong> <strong>static</strong> <strong>final</strong> String DATA_KEY = Transcoder.DATA_KEY;
<a name="572" href="#572">572</a> 
<a name="573" href="#573">573</a>     <strong>private</strong> Map&lt;String, Transcoder> transcoders;
<a name="574" href="#574">574</a>     <strong>public</strong> <strong>void</strong> setTranscoders(Map&lt;String, Transcoder> transcoders) {
<a name="575" href="#575">575</a>         <strong>this</strong>.transcoders = transcoders;
<a name="576" href="#576">576</a>     }
<a name="577" href="#577">577</a>     <em>/**<em>*</em></em>
<a name="578" href="#578">578</a> <em>     * Override the transcoder used for a specific format</em>
<a name="579" href="#579">579</a> <em>     * @param transcoder a transcoder implementation</em>
<a name="580" href="#580">580</a> <em>     */</em>
<a name="581" href="#581">581</a>     <strong>public</strong> <strong>void</strong> setTranscoder(Transcoder transcoder) {
<a name="582" href="#582">582</a>         <strong>if</strong> (transcoder == <strong>null</strong>) {
<a name="583" href="#583">583</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"transcoder cannot be null"</span>);
<a name="584" href="#584">584</a>         }
<a name="585" href="#585">585</a>         <strong>if</strong> (transcoders == <strong>null</strong>) {
<a name="586" href="#586">586</a>             getTranscoder(Formats.XML);
<a name="587" href="#587">587</a>         }
<a name="588" href="#588">588</a>         String format = transcoder.getHandledFormat();
<a name="589" href="#589">589</a>         <strong>if</strong> (format != <strong>null</strong> &amp;&amp; transcoder != <strong>null</strong>) {
<a name="590" href="#590">590</a>             transcoders.put(format, transcoder);
<a name="591" href="#591">591</a>         }
<a name="592" href="#592">592</a>     }
<a name="593" href="#593">593</a>     <strong>public</strong> Transcoder getTranscoder(String format) {
<a name="594" href="#594">594</a>         <strong>if</strong> (transcoders == <strong>null</strong>) {
<a name="595" href="#595">595</a>             transcoders = <strong>new</strong> HashMap&lt;String, Transcoder>();
<a name="596" href="#596">596</a>             JSONTranscoder jt = <strong>new</strong> JSONTranscoder(<strong>true</strong>, <strong>true</strong>, false);
<a name="597" href="#597">597</a>             transcoders.put(jt.getHandledFormat(), jt);
<a name="598" href="#598">598</a>             XMLTranscoder xt = <strong>new</strong> XMLTranscoder(<strong>true</strong>, <strong>true</strong>, false, false);
<a name="599" href="#599">599</a>             transcoders.put(xt.getHandledFormat(), xt);
<a name="600" href="#600">600</a>             HTMLTranscoder ht = <strong>new</strong> HTMLTranscoder();
<a name="601" href="#601">601</a>             transcoders.put(ht.getHandledFormat(), ht);
<a name="602" href="#602">602</a>         }
<a name="603" href="#603">603</a>         Transcoder transcoder = transcoders.get(format);
<a name="604" href="#604">604</a>         <strong>if</strong> (transcoder == <strong>null</strong>) {
<a name="605" href="#605">605</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Failed to find a transcoder for format, none exists, cannot encode or decode data for format: "</span> + format);
<a name="606" href="#606">606</a>         }
<a name="607" href="#607">607</a>         <strong>return</strong> transcoder;
<a name="608" href="#608">608</a>     }
<a name="609" href="#609">609</a> 
<a name="610" href="#610">610</a>     <em>/**<em>*</em></em>
<a name="611" href="#611">611</a> <em>     * Encode data into a given format, can handle any java object,</em>
<a name="612" href="#612">612</a> <em>     * note that unsupported formats will result in an exception</em>
<a name="613" href="#613">613</a> <em>     * </em>
<a name="614" href="#614">614</a> <em>     * @param data the data to encode (can be a POJO or Map or pretty much any java object)</em>
<a name="615" href="#615">615</a> <em>     * @param format the format to use for output (from {@link Formats})</em>
<a name="616" href="#616">616</a> <em>     * @param name (optional) the name to use for the encoded data (e.g. root node for XML)</em>
<a name="617" href="#617">617</a> <em>     * @param properties (optional) extra properties to add into the encoding, ignored if encoded object is not a map or bean</em>
<a name="618" href="#618">618</a> <em>     * @return the encoded string</em>
<a name="619" href="#619">619</a> <em>     * @throws UnsupportedOperationException if the data cannot be encoded</em>
<a name="620" href="#620">620</a> <em>     */</em>
<a name="621" href="#621">621</a>     <strong>public</strong> String encodeData(Object data, String format, String name, Map&lt;String, Object> properties) {
<a name="622" href="#622">622</a>         <strong>if</strong> (format == <strong>null</strong>) {
<a name="623" href="#623">623</a>             format = Formats.XML;
<a name="624" href="#624">624</a>         }
<a name="625" href="#625">625</a>         String encoded = <span class="string">""</span>;
<a name="626" href="#626">626</a>         <strong>if</strong> (data != <strong>null</strong>) {
<a name="627" href="#627">627</a>             Transcoder transcoder = getTranscoder(format);
<a name="628" href="#628">628</a>             <strong>try</strong> {
<a name="629" href="#629">629</a>                 encoded = transcoder.encode(data, name, properties);
<a name="630" href="#630">630</a>             } <strong>catch</strong> (RuntimeException e) {
<a name="631" href="#631">631</a>                 <em class="comment">// convert failure to UOE</em>
<a name="632" href="#632">632</a>                 <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Failure encoding data ("</span>+data+<span class="string">") of type ("</span>+data.getClass()+<span class="string">"): "</span> + e.getMessage(), e);
<a name="633" href="#633">633</a>             }
<a name="634" href="#634">634</a>         }
<a name="635" href="#635">635</a>         <strong>return</strong> encoded;
<a name="636" href="#636">636</a>     }
<a name="637" href="#637">637</a> 
<a name="638" href="#638">638</a>     <em>/**<em>*</em></em>
<a name="639" href="#639">639</a> <em>     * Decode a string of a specified format into a java map &lt;br/> </em>
<a name="640" href="#640">640</a> <em>     * Returned map can be fed into the {@link ReflectUtils#populate(Object, Map)} if you want to convert it</em>
<a name="641" href="#641">641</a> <em>     * into a known object type &lt;br/> </em>
<a name="642" href="#642">642</a> <em>     * Types are likely to require conversion as guesses are made about the right formats,</em>
<a name="643" href="#643">643</a> <em>     * use of the {@link ReflectUtils#convert(Object, Class)} method is recommended</em>
<a name="644" href="#644">644</a> <em>     * </em>
<a name="645" href="#645">645</a> <em>     * @param data encoded data</em>
<a name="646" href="#646">646</a> <em>     * @param format the format of the encoded data (from {@link Formats})</em>
<a name="647" href="#647">647</a> <em>     * @return a map containing all the data derived from the encoded data</em>
<a name="648" href="#648">648</a> <em>     * @throws UnsupportedOperationException if the data cannot be decoded</em>
<a name="649" href="#649">649</a> <em>     */</em>
<a name="650" href="#650">650</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="651" href="#651">651</a>     <strong>public</strong> Map&lt;String, Object> decodeData(String data, String format) {
<a name="652" href="#652">652</a>         <strong>if</strong> (format == <strong>null</strong>) {
<a name="653" href="#653">653</a>             format = Formats.XML;
<a name="654" href="#654">654</a>         }
<a name="655" href="#655">655</a>         Map&lt;String, Object> decoded = <strong>new</strong> ArrayOrderedMap&lt;String, Object>();
<a name="656" href="#656">656</a>         <strong>if</strong> (data != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(data)) {
<a name="657" href="#657">657</a>             Object decode = <strong>null</strong>;
<a name="658" href="#658">658</a>             Transcoder transcoder = getTranscoder(format);
<a name="659" href="#659">659</a>             <strong>try</strong> {
<a name="660" href="#660">660</a>                 decode = transcoder.decode(data);
<a name="661" href="#661">661</a>                 <strong>if</strong> (decode instanceof Map) {
<a name="662" href="#662">662</a>                     decoded = (Map&lt;String, Object>) decode;
<a name="663" href="#663">663</a>                 } <strong>else</strong> {
<a name="664" href="#664">664</a>                     decoded.put(DATA_KEY, decode);
<a name="665" href="#665">665</a>                 }
<a name="666" href="#666">666</a>             } <strong>catch</strong> (RuntimeException e) {
<a name="667" href="#667">667</a>                 <em class="comment">// convert failure to UOE</em>
<a name="668" href="#668">668</a>                 <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Failure decoding data ("</span>+data+<span class="string">") for format ("</span>+format+<span class="string">"): "</span> + e.getMessage(), e);
<a name="669" href="#669">669</a>             }
<a name="670" href="#670">670</a>         }
<a name="671" href="#671">671</a>         <strong>return</strong> decoded;
<a name="672" href="#672">672</a>     }
<a name="673" href="#673">673</a> 
<a name="674" href="#674">674</a>     <em>/**<em>*</em></em>
<a name="675" href="#675">675</a> <em>     * Using GSON is hopeless:</em>
<a name="676" href="#676">676</a> <em>     * <a href="http://code.google.com/p/google-gson/issues/detail?id=45" target="alexandria_uri">http://code.google.com/p/google-gson/issues/detail?id=45</a></em>
<a name="677" href="#677">677</a> <em>     * </em>
<a name="678" href="#678">678</a> <em>     * Gson gson = getGson();</em>
<a name="679" href="#679">679</a> <em>     * encoded = gson.toJson(data, new TypeToken&lt;Map&lt;String, Object>>() {}.getType());</em>
<a name="680" href="#680">680</a> <em>     * decoded = gson.fromJson(data, new TypeToken&lt;Map&lt;String, Object>>() {}.getType());</em>
<a name="681" href="#681">681</a> <em>     */</em>
<a name="682" href="#682">682</a>     <em class="comment">//    protected SoftReference&lt;Gson> gsonCoder = null;</em>
<a name="683" href="#683">683</a>     <em class="comment">//    </em><em>/**<em>*</em></em>
<a name="684" href="#684">684</a> <em>    //     * Get the gson encoder in an efficient way to avoid recreating it over and over and over again</em>
<a name="685" href="#685">685</a> <em>    //     * @return the gson encoder</em>
<a name="686" href="#686">686</a> <em>    //     */</em>
<a name="687" href="#687">687</a>     <em class="comment">//    protected Gson getGson() {</em>
<a name="688" href="#688">688</a>     <em class="comment">//        Gson gson = gsonCoder == null ? null : gsonCoder.get();</em>
<a name="689" href="#689">689</a>     <em class="comment">//        if (gson == null) {</em>
<a name="690" href="#690">690</a>     <em class="comment">//            gson = new GsonBuilder().serializeNulls().setPrettyPrinting().create();</em>
<a name="691" href="#691">691</a>     <em class="comment">//            gsonCoder = new SoftReference&lt;Gson>(gson);</em>
<a name="692" href="#692">692</a>     <em class="comment">//        }</em>
<a name="693" href="#693">693</a>     <em class="comment">//        return gson;</em>
<a name="694" href="#694">694</a>     <em class="comment">//    }</em>
<a name="695" href="#695">695</a> 
<a name="696" href="#696">696</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

